FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package dk.ehealth.sundhed.fhir.ig.core#current (47 ms)

Package dk.ehealth.sundhed.fhir.ig.core
Type OperationDefinition
Id Id
FHIR Version R4
Source http://ehealth.sundhed.dk/fhir/https://build.fhir.org/ig/fut-infrastructure/implementation-guide/OperationDefinition--s-search-measurements-bundle-limit.html
Url https://measurement.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-search-measurements-bundle-limit
Version 3.3.0
Status active
Date 2024-09-18T12:39:44+00:00
Name search-measurements-bundle-limit
Title Search measurements bundle limit
Experimental False
Description The search-measurements-bundle-limit operation searches for a number of bundles of related resources having Observations, Media or QuestionnaireResponses matching the search criteria. ### Parameter description - patient: Find resource(s) referring the specified patient - Reference(eHealth Patient). - episodeOfCare: Find resource(s) referring the specified episode of care - Reference(eHealth EpisodeOfCare). - count: The number of bundles to return, max allowed value is 100 - Integer. - start: Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted after this time. The result bundles will be sorted in ascending order - DateTime. - end: Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted before this time. The result bundles will be sorted in descending order - DateTime. - based-on: Resources(s) must be based on any of the specified service requests - Reference(eHealth ServiceRequest). - _tag: When specified, resource(s) must have at least one of the specified tags in meta data - for instance a Coding(ehealth-system CodeSystem) or on token form: http://ehealth.sundhed.dk/cs/ehealth-system|xa. Note that the _tag functions as an optional filter, not as a selection criteria in the way the other parameters work. One of either "start" or "end", along with the "count" parameter must always be specified. Additionally at least "patient" or "episodeOfCare" or "serviceRequest" must be specified. ### Output description The result of this operation returns a Bundle with a list of nested Bundles having resources matching the search parameters. The number of nested Bundles depends on the count parameter. Each of the nested bundles contains the full set of related eHealth Observation, eHealth Media, eHealth QuestionnaireResponse and eHealth Provenance resources, from the same submission request. Related resources are the set of resources created by a single invocation of the submit-measurement operation.
Type false
Kind operation

Resources that use this resource

CapabilityStatement
measurement measurement

Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition -s-search-measurements-bundle-limit

URL: [base]/$search-measurements-bundle-limit

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INpatient0..1Reference

Find resource(s) referring the specified patient - Reference(eHealth Patient).

INepisodeOfCare0..1Reference

Find resource(s) referring the specified episode of care - Reference(eHealth EpisodeOfCare).

INcount1..1integer

The number of bundles to return, max allowed value is 100 - Integer.

INstart0..1dateTime

Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted after this time. The result bundles will be sorted in ascending order - DateTime.

INend0..1dateTime

Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted before this time. The result bundles will be sorted in descending order - DateTime.

INbased-on0..*Reference

Resources(s) must be based on any of the specified service requests - Reference(eHealth ServiceRequest).

IN_tag0..*Coding

Search for resources which have the given tag.

OUTbundle0..1Bundle

Source

{
  "resourceType" : "OperationDefinition",
  "id" : "-s-search-measurements-bundle-limit",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition -s-search-measurements-bundle-limit</b></p><a name=\"-s-search-measurements-bundle-limit\"> </a><a name=\"hc-s-search-measurements-bundle-limit\"> </a><a name=\"-s-search-measurements-bundle-limit-en-US\"> </a><p>URL: [base]/$search-measurements-bundle-limit</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>Find resource(s) referring the specified patient - Reference(eHealth Patient).</p>\n</div></td></tr><tr><td>IN</td><td>episodeOfCare</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>Find resource(s) referring the specified episode of care - Reference(eHealth EpisodeOfCare).</p>\n</div></td></tr><tr><td>IN</td><td>count</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>The number of bundles to return, max allowed value is 100 - Integer.</p>\n</div></td></tr><tr><td>IN</td><td>start</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted after this time. The result bundles will be sorted in ascending order - DateTime.</p>\n</div></td></tr><tr><td>IN</td><td>end</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted before this time. The result bundles will be sorted in descending order - DateTime.</p>\n</div></td></tr><tr><td>IN</td><td>based-on</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>Resources(s) must be based on any of the specified service requests - Reference(eHealth ServiceRequest).</p>\n</div></td></tr><tr><td>IN</td><td>_tag</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td/><td><div><p>Search for resources which have the given tag.</p>\n</div></td></tr><tr><td>OUT</td><td>bundle</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td/></tr></table></div>"
  },
  "url" : "https://measurement.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-search-measurements-bundle-limit",
  "version" : "3.3.0",
  "name" : "search-measurements-bundle-limit",
  "title" : "Search measurements bundle limit",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-09-18T12:39:44+00:00",
  "publisher" : "Den telemedicinske infrastruktur (eHealth Infrastructure)",
  "contact" : [
    {
      "name" : "Den telemedicinske infrastruktur (eHealth Infrastructure)",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://ehealth.sundhed.dk"
        }
      ]
    }
  ],
  "description" : "The search-measurements-bundle-limit operation searches for a number of bundles of related resources having Observations, Media or QuestionnaireResponses matching the search criteria.\n\n\n### Parameter description\n- patient: Find resource(s) referring the specified patient - Reference(eHealth Patient).\n- episodeOfCare: Find resource(s) referring the specified episode of care - Reference(eHealth EpisodeOfCare).\n- count: The number of bundles to return, max allowed value is 100 - Integer.\n- start: Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted after this time. The result bundles will be sorted in ascending order - DateTime.\n- end: Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted before this time. The result bundles will be sorted in descending order - DateTime.\n- based-on: Resources(s) must be based on any of the specified service requests - Reference(eHealth ServiceRequest).\n- _tag: When specified, resource(s) must have at least one of the specified tags in meta data - for instance a Coding(ehealth-system CodeSystem) or on token form: http://ehealth.sundhed.dk/cs/ehealth-system|xa. Note that the _tag functions as an optional filter, not as a selection criteria in the way the other parameters work.\n\n\nOne of either \"start\" or \"end\", along with the \"count\" parameter must always be specified.\n\nAdditionally at least \"patient\" or \"episodeOfCare\" or \"serviceRequest\" must be specified.\n\n### Output description\n\nThe result of this operation returns a Bundle with a list of nested Bundles having resources matching the search parameters. The number of nested Bundles depends on the count parameter.\n\nEach of the nested bundles contains the full set of related eHealth Observation, eHealth Media, eHealth QuestionnaireResponse and eHealth Provenance resources, from the same submission request.\n\nRelated resources are the set of resources created by a single invocation of the submit-measurement operation.\n\n",
  "affectsState" : false,
  "code" : "search-measurements-bundle-limit",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "patient",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Find resource(s) referring the specified patient - Reference(eHealth Patient).",
      "type" : "Reference"
    },
    {
      "name" : "episodeOfCare",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Find resource(s) referring the specified episode of care - Reference(eHealth EpisodeOfCare).",
      "type" : "Reference"
    },
    {
      "name" : "count",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The number of bundles to return, max allowed value is 100 - Integer.",
      "type" : "integer"
    },
    {
      "name" : "start",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted after this time. The result bundles will be sorted in ascending order - DateTime.",
      "type" : "dateTime"
    },
    {
      "name" : "end",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted before this time. The result bundles will be sorted in descending order - DateTime.",
      "type" : "dateTime"
    },
    {
      "name" : "based-on",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Resources(s) must be based on any of the specified service requests - Reference(eHealth ServiceRequest).",
      "type" : "Reference"
    },
    {
      "name" : "_tag",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Search for resources which have the given tag.",
      "type" : "Coding"
    },
    {
      "name" : "bundle",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "type" : "Bundle"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.